SwaggerClient-php

This is the API for the Estuary application.

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 0.0.0
• Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen For more information, please visit https://docs.estuary.tech/feedback

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\AdminApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->adminMinersGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->adminMinersGet: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\AdminApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = array("body_example"); // string[] | Peer ids

try {
    $result = $apiInstance->adminPeeringPeersDelete($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->adminPeeringPeersDelete: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\AdminApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->adminPeeringPeersGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->adminPeeringPeersGet: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\AdminApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = array(new \Swagger\Client\Model\PeeringPeeringPeer()); // \Swagger\Client\Model\PeeringPeeringPeer[] | Peering Peer array

try {
    $result = $apiInstance->adminPeeringPeersPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->adminPeeringPeersPost: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\AdminApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->adminPeeringStartPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->adminPeeringStartPost: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\AdminApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->adminPeeringStatusGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->adminPeeringStatusGet: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\AdminApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->adminPeeringStopPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->adminPeeringStopPost: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\AdminApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->adminSystemConfigGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->adminSystemConfigGet: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\AdminApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->adminUsersGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminApi->adminUsersGet: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to //api.estuary.tech/

Class	Method	HTTP request	Description
AdminApi	adminMinersGet	GET /admin/miners/	Get all miners
AdminApi	adminPeeringPeersDelete	DELETE /admin/peering/peers	Remove peers on Peering Service
AdminApi	adminPeeringPeersGet	GET /admin/peering/peers	List all Peering peers
AdminApi	adminPeeringPeersPost	POST /admin/peering/peers	Add peers on Peering Service
AdminApi	adminPeeringStartPost	POST /admin/peering/start	Start Peering
AdminApi	adminPeeringStatusGet	GET /admin/peering/status	Check Peering Status
AdminApi	adminPeeringStopPost	POST /admin/peering/stop	Stop Peering
AdminApi	adminSystemConfigGet	GET /admin/system/config	Get systems(estuary/shuttle) config
AdminApi	adminUsersGet	GET /admin/users	Get all users
AutoretrieveApi	adminAutoretrieveInitPost	POST /admin/autoretrieve/init	Register autoretrieve server
AutoretrieveApi	adminAutoretrieveListGet	GET /admin/autoretrieve/list	List autoretrieve servers
AutoretrieveApi	autoretrieveHeartbeatPost	POST /autoretrieve/heartbeat	Marks autoretrieve server as up
CollectionsApi	collectionsColuuidCommitPost	POST /collections/{coluuid}/commit	Produce a CID of the collection contents
CollectionsApi	collectionsColuuidContentsDelete	DELETE /collections/{coluuid}/contents	Deletes a content from a collection
CollectionsApi	collectionsColuuidDelete	DELETE /collections/{coluuid}	Deletes a collection
CollectionsApi	collectionsColuuidGet	GET /collections/{coluuid}	Get contents in a collection
CollectionsApi	collectionsColuuidPost	POST /collections/{coluuid}	Add contents to a collection
CollectionsApi	collectionsFsAddPost	POST /collections/fs/add	Add a file to a collection
CollectionsApi	collectionsGet	GET /collections/	List all collections
CollectionsApi	collectionsPost	POST /collections/	Create a new collection
ContentApi	adminInvitesCodePost	POST /admin/invites/{code}	Create an Estuary invite
ContentApi	adminInvitesGet	GET /admin/invites	Get Estuary invites
ContentApi	contentAddCarPost	POST /content/add-car	Add Car object
ContentApi	contentAddIpfsPost	POST /content/add-ipfs	Add IPFS object
ContentApi	contentAddPost	POST /content/add	Add new content
ContentApi	contentAggregatedContentGet	GET /content/aggregated/{content}	Get aggregated content stats
ContentApi	contentAllDealsGet	GET /content/all-deals	Get all deals for a user
ContentApi	contentBwUsageContentGet	GET /content/bw-usage/{content}	Get content bandwidth
ContentApi	contentContentsGet	GET /content/contents	Get user contents
ContentApi	contentCreatePost	POST /content/create	Add a new content
ContentApi	contentDealsGet	GET /content/deals	Content with deals
ContentApi	contentEnsureReplicationDatacidGet	GET /content/ensure-replication/{datacid}	Ensure Replication
ContentApi	contentFailuresContentGet	GET /content/failures/{content}	List all failures for a content
ContentApi	contentIdGet	GET /content/{id}	Content
ContentApi	contentListGet	GET /content/list	List all pinned content
ContentApi	contentStagingZonesGet	GET /content/staging-zones	Get staging zone for user, excluding its contents
ContentApi	contentStagingZonesStagingZoneContentsGet	GET /content/staging-zones/{staging_zone}/contents	Get contents for a staging zone
ContentApi	contentStagingZonesStagingZoneGet	GET /content/staging-zones/{staging_zone}	Get staging zone without its contents field populated
ContentApi	contentStatsGet	GET /content/stats	Get content statistics
ContentApi	contentStatusIdGet	GET /content/status/{id}	Content Status
DealsApi	dealEstimatePost	POST /deal/estimate	Estimate the cost of a deal
DealsApi	dealInfoDealidGet	GET /deal/info/{dealid}	Get Deal Info
DealsApi	dealProposalPropcidGet	GET /deal/proposal/{propcid}	Get Proposal
DealsApi	dealQueryMinerGet	GET /deal/query/{miner}	Query Ask
DealsApi	dealStatusByProposalPropcidGet	GET /deal/status-by-proposal/{propcid}	Get Deal Status by PropCid
DealsApi	dealStatusMinerPropcidGet	GET /deal/status/{miner}/{propcid}	Deal Status
DealsApi	dealTransferInProgressGet	GET /deal/transfer/in-progress	Transfer In Progress
DealsApi	dealTransferStatusPost	POST /deal/transfer/status	Transfer Status
DealsApi	dealsFailuresGet	GET /deals/failures	Get storage failures for user
DealsApi	dealsMakeMinerPost	POST /deals/make/{miner}	Make Deal
DealsApi	dealsStatusDealGet	GET /deals/status/{deal}	Get Deal Status
DealsApi	publicDealsFailuresGet	GET /public/deals/failures	Get storage failures
DealsApi	publicMinersStorageQueryMinerGet	GET /public/miners/storage/query/{miner}	Query Ask
DefaultApi	viewerGet	GET /viewer	Fetch viewer details
MetricsApi	publicMetricsDealsOnChainGet	GET /public/metrics/deals-on-chain	Get deal metrics
MinerApi	minerClaimMinerGet	GET /miner/claim/{miner}	Get Claim Miner Message
MinerApi	minerClaimPost	POST /miner/claim	Claim Miner
MinerApi	minerSetInfoMinerPut	PUT /miner/set-info/{miner}	Set Miner Info
MinerApi	minerSuspendMinerPost	POST /miner/suspend/{miner}	Suspend Miner
MinerApi	minerUnsuspendMinerPut	PUT /miner/unsuspend/{miner}	Unuspend Miner
MinerApi	publicMinersDealsMinerGet	GET /public/miners/deals/{miner}	Get all miners deals
MinerApi	publicMinersStatsMinerGet	GET /public/miners/stats/{miner}	Get miner stats
NetApi	adminMinersGet	GET /admin/miners/	Get all miners
NetApi	publicMinersFailuresMinerGet	GET /public/miners/failures/{miner}	Get all miners
NetApi	publicNetAddrsGet	GET /public/net/addrs	Net Addrs
NetApi	publicNetPeersGet	GET /public/net/peers	Net Peers
PinningApi	pinningPinsGet	GET /pinning/pins	List all pin status objects
PinningApi	pinningPinsPinidDelete	DELETE /pinning/pins/{pinid}	Delete a pinned object
PinningApi	pinningPinsPinidGet	GET /pinning/pins/{pinid}	Get a pin status object
PinningApi	pinningPinsPinidPost	POST /pinning/pins/{pinid}	Replace a pinned object
PinningApi	pinningPinsPost	POST /pinning/pins	Add and pin object
PublicApi	getCidGet	GET /get/{cid}	Get Full Content by Cid
PublicApi	publicByCidCidGet	GET /public/by-cid/{cid}	Get Content by Cid
PublicApi	publicInfoGet	GET /public/info	Get public node info
PublicApi	publicMetricsDealsOnChainGet	GET /public/metrics/deals-on-chain	Get deal metrics
PublicApi	publicMinersDealsMinerGet	GET /public/miners/deals/{miner}	Get all miners deals
PublicApi	publicMinersFailuresMinerGet	GET /public/miners/failures/{miner}	Get all miners
PublicApi	publicMinersStatsMinerGet	GET /public/miners/stats/{miner}	Get miner stats
PublicApi	publicNetAddrsGet	GET /public/net/addrs	Net Addrs
PublicApi	publicNetPeersGet	GET /public/net/peers	Net Peers
PublicApi	publicStatsGet	GET /public/stats	Public stats
UserApi	userApiKeysGet	GET /user/api-keys	Get API keys for a user
UserApi	userApiKeysKeyOrHashDelete	DELETE /user/api-keys/{key_or_hash}	Revoke a User API Key.
UserApi	userApiKeysPost	POST /user/api-keys	Create API keys for a user
UserApi	userExportGet	GET /user/export	Export user data
UserApi	userStatsGet	GET /user/stats	Get stats for the current user

Documentation For Models

• AddressAddress
• ApiChannelIDParam
• ApiClaimMsgResponse
• ApiClaimResponse
• ApiCreateCollectionBody
• ApiDeleteContentFromCollectionBody
• ApiEmptyResp
• ApiEstimateDealBody
• ApiGetApiKeysResp
• ApiMinerResp
• ApiPublicNodeInfo
• AutoretrieveInitBody
• CidCid
• CollectionsCidType
• CollectionsCollection
• CollectionsCollectionListResponse
• ContentAddBody
• MinerClaimMinerBody
• MinerMinerChainInfo
• MinerMinerSetInfoParams
• MinerSuspendMinerBody
• PeeringPeeringPeer
• TypesIpfsListPinStatusResponse
• TypesIpfsPin
• TypesIpfsPinStatusResponse
• TypesPinningStatus
• UtilContentAddResponse
• UtilContentCreateBody
• UtilContentType
• UtilDbCID
• UtilHttpError
• UtilUserSettings
• UtilViewerResponse

Documentation For Authorization

bearerAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author